
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>lmp.derivs &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="lmp.calculate" href="lmp.calculate.html" />
    <link rel="prev" title="bent_plume_model.width_projection" href="bent_plume_model.width_projection.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="lmp-derivs">
<h1>lmp.derivs<a class="headerlink" href="#lmp-derivs" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="lmp.derivs">
<code class="sig-prename descclassname">lmp.</code><code class="sig-name descname">derivs</code><span class="sig-paren">(</span><em class="sig-param">t</em>, <em class="sig-param">q</em>, <em class="sig-param">q0_local</em>, <em class="sig-param">q1_local</em>, <em class="sig-param">profile</em>, <em class="sig-param">p</em>, <em class="sig-param">particles</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/lmp.html#derivs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#lmp.derivs" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate the derivatives for the system of ODEs for a Lagrangian plume</p>
<p>Calculates the right-hand-side of the system of ODEs for a Lagrangian 
plume integral model.  The continuous phase model matches very closely 
the model of Lee and Cheung (1990), with adaptations for the shear 
entrainment following Jirka (2004).  Multiphase extensions following the
strategy in Socolofsky et al. (2008) with adaptation to Lagrangian plume
models by Johansen (2000, 2003) and Yapa and Zheng (1997).</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>t</strong><span class="classifier">float</span></dt><dd><p>Current value for the independent variable (time in s).</p>
</dd>
<dt><strong>q</strong><span class="classifier">ndarray</span></dt><dd><p>Current value for the plume state space vector.</p>
</dd>
<dt><strong>q0_local</strong><span class="classifier"><cite>bent_plume_model.LagElement</cite></span></dt><dd><p>Object containing the numerical solution at the previous time step</p>
</dd>
<dt><strong>q1_local</strong><span class="classifier"><cite>bent_plume_model.LagElement</cite></span></dt><dd><p>Object containing the numerical solution at the current time step</p>
</dd>
<dt><strong>profile</strong><span class="classifier"><cite>ambient.Profile</cite> object</span></dt><dd><p>The ambient CTD object used by the simulation.</p>
</dd>
<dt><strong>p</strong><span class="classifier"><cite>ModelParams</cite> object</span></dt><dd><p>Object containing the fixed model parameters for the bent
plume model.</p>
</dd>
<dt><strong>particles</strong><span class="classifier">list of <cite>Particle</cite> objects</span></dt><dd><p>List of <cite>bent_plume_model.Particle</cite> objects containing the dispersed 
phase local conditions and behavior.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>yp</strong><span class="classifier">ndarray</span></dt><dd><p>A vector of the derivatives of the plume state space.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="lmp.calculate.html#lmp.calculate" title="lmp.calculate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">calculate</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/bpm.html">Overview of Bent Plume Model Module</a><ul>
      <li>Previous: <a href="bent_plume_model.width_projection.html" title="previous chapter">bent_plume_model.width_projection</a></li>
      <li>Next: <a href="lmp.calculate.html" title="next chapter">lmp.calculate</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/bpm/lmp.derivs.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>